home *** CD-ROM | disk | FTP | other *** search
- // GXMPS.idl : IDL source for GXMPS.dll
- //
-
- // This file will be processed by the MIDL tool to
- // produce the type library (GXMPS.tlb) and marshalling code.
-
- import "imsigx.idl";
- import "ocidl.idl";
-
- /**
- * A TurboCAD drawing's Paper Space
- * Allows access to the Papaer Space's properties.
- * Allows access to the graphics contained within Papaer Space.
- */
- [
- object
- ,uuid(6A48114C-E531-11CF-A115-00A024158DAF)
- ,oleautomation
- ,dual
- ,helpcontext(0x12000000)
- ,helpstring("A TurboCAD drawing's Paper Space.")
- ]
- interface PaperSpace : IDispatch
- {
-
- /**
- * Returns an Application object that represents the owner of the specified object.
- */
- [
- propget
- ,helpcontext(0x12000001)
- ,helpstring("Returns an Application object that represents the creator of the specified object.")
- ]
- HRESULT Application(
- [out, retval] IApplication** application
- );
-
- /**
- * Returns the index of the item in the collection.
- */
- [
- propget
- ,helpcontext(0x12000002)
- ,helpstring("Returns the index of the item in the collection.")
- ]
- HRESULT Index(
- [out, retval] long* index
- );
-
- /**
- * Returns the name of the object, as a string.
- */
- [
- propget
- ,helpcontext(0x12000003)
- ,helpstring("Returns the name of the object, as a string.")
- ]
- HRESULT Name(
- [out, retval] BSTR* name
- );
-
- /**
- * Returns the parent object for the specified object.
- */
- [
- propget
- ,helpcontext(0x12000004)
- ,helpstring("Returns the parent object for the specified object.")
- ]
- HRESULT Parent(
- [out, retval] IDispatch** parent
- );
-
- /**
- * Returns the internal table entry ID.
- * Private.
- */
- [
- propget
- ,restricted
- ,helpcontext(0x12000005)
- ,helpstring("Private. Returns the internal table entry ID.")
- ]
- HRESULT _TableEntryID(
- [out, retval] long* prop
- );
-
- ///////////////////////////// Properties \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
-
- /**
- * Returns the active Window object.
- *
- */
- [
- propget
- ,helpcontext(0x12000006)
- ,helpstring("Returns the active Window object.")
- ,restricted, hidden
- ]
- HRESULT ActiveWindow(
- [out, retval] Window** prop // The active Window object.
- );
-
- /**
- * Returns the PaperSpace object's Graphics collection.
- */
- [
- propget
- ,helpcontext(0x12000007)
- ,helpstring("Returns the PaperSpace object's Graphics collection.")
- ]
- HRESULT Graphics(
- [out, retval] Graphics** prop // The Graphics collection.
- );
-
- /**
- * Returns the PaperSpace object's GraphicSets collection.
- */
- [
- propget
- ,helpcontext(0x12000008)
- ,helpstring("Returns the PaperSpace object's GraphicSets collection.")
- ,restricted, hidden
- ]
- HRESULT GraphicSets(
- [out, retval] GraphicSets** prop // The GraphicSets collection.
- );
-
- /**
- * Returns the PaperSpace object's Grid object.
- */
- [
- propget
- ,helpcontext(0x12000009)
- ,helpstring("Returns the PaperSpace object's Grid object.")
- ,restricted, hidden
- ]
- HRESULT Grid(
- [out, retval] IGrid** prop // The Grid object.
- );
-
- /**
- * Sets the PaperSpace object's Grid object.
- */
- [
- propput
- ,helpcontext(0x12000009)
- ,helpstring("Sets the PaperSpace object's Grid object.")
- ,restricted, hidden
- ]
-
- HRESULT Grid(
- [in] IGrid* prop // The Grid object.
- );
-
- /**
- * Returns the PaperSpace object's PgSetObj.
- */
- [
- propget
- ,helpcontext(0x1200000A)
- ,helpstring("Returns the PaperSpace object's PgSetObj.")
- ,restricted, hidden
- ]
- HRESULT PageSetup(
- [out, retval] PageSetup** prop // The PgSetObj.
- );
-
- /**
- * Returns the PaperSpace object's Properties collection.
- * For the complete list of available PaperSpace Properties, follow
- * <A HREF="dwgprops.html">this link</A>.
- *
- */
- [
- propget
- ,helpcontext(0x1200000B)
- ,helpstring("Returns the PaperSpace object's Properties collection.")
- ]
- HRESULT Properties(
- [out, retval] Properties** prop // The Properties collection.
- );
-
- /**
- * Returns the PaperSpace object's Selection object.
- */
- [
- propget
- ,helpcontext(0x1200000C)
- ,helpstring("Returns the PaperSpace object's Selection object.")
- ,restricted, hidden
- ]
- HRESULT Selection(
- [out, retval] Selection** prop // The Selection object.
- );
-
- /**
- * Returns the object's Tables collection.
- */
- [
- propget
- ,helpcontext(0x1200000D)
- ,helpstring("Returns the object's Tables collection.")
- ,restricted, hidden
- ]
- HRESULT Tables(
- [out, retval] Tables** prop // The Tables collection.
- );
-
- /**
- * Returns the PaperSpace object's Views collection.
- */
- [
- propget
- ,helpcontext(0x1200000E)
- ,helpstring("Returns the PaperSpace object's Views collection.")
- ,restricted, hidden
- ]
- HRESULT Views(
- [out, retval] Views** prop // The Views collection.
- );
-
- /**
- * Returns the PaperSpace object's Windows collection.
- */
- [
- propget
- ,helpcontext(0x1200000F)
- ,helpstring("Returns the PaperSpace object's Windows collection.")
- ,restricted, hidden
- ]
- HRESULT Windows(
- [out, retval] Windows** prop // The Windows collection.
- );
-
- /**
- * Returns the internal handle associated with the PaperSpace object.
- * Private.
- */
- [
- propget
- ,restricted
- ,helpcontext(0x12000010)
- ,helpstring("Private. Returns the internal handle associated with the PaperSpace object.")
- ]
- HRESULT _Handle(
- [out, retval] long* prop // The internal handle.
- );
-
- /////////////////////////////// Methods \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
-
- /**
- * Makes this object the active PaperSpace object.
- *
- */
- [
- helpcontext(0x12000011)
- ,helpstring("Makes this object the active PaperSpace object.")
- ]
- HRESULT Activate(
- );
-
- /**
- * Opens a new URecObj in the PaperSpace object.
- * Use UndoRecord.AddGraphic, etc. to add graphics to the record.
- * Use UndoRecord.Close to close the record and add it to the Undo list.
- *
- */
- [
- helpcontext(0x12000012)
- ,helpstring("Opens a new URecObj in the PaperSpace object.")
- ,restricted, hidden
- ]
- HRESULT AddUndoRecord(
- [in] BSTR MenuText, // The prompt to appear in the Undo list.
- [out, retval] UndoRecord** prop // The new URecObj.
- );
-
- /**
- * Adds the contents of a file to the PaperSpace object.
- */
- [
- helpcontext(0x12000013)
- ,helpstring("Adds the contents of a file to the PaperSpace object.")
- ,restricted, hidden
- ]
- HRESULT InsertFile(
- BSTR FileName, // The name of the file.
- [in, optional] VARIANT* Filter // The preferred filter to use to open the file.
- );
-
- /**
- * Creates a new Window object for the PaperSpace object.
- */
- [
- helpcontext(0x12000014)
- ,helpstring("Creates a new Window object for the PaperSpace object.")
- ,restricted, hidden
- ]
- HRESULT NewWindow(
- [out, retval] Window** prop // The new Window object.
- );
-
- /**
- * Pastes the contents of the Clipboard onto the PaperSpace object.
- */
- [
- helpcontext(0x12000015)
- ,helpstring("Pastes the contents of the Clipboard onto the PaperSpace object.")
- ,restricted, hidden
- ]
- HRESULT Paste(
- );
-
- /**
- * Pastes the contents of the Clipboard onto the PaperSpace object.
- */
- [
- helpcontext(0x12000016)
- ,helpstring("Pastes the contents of the Clipboard onto the PaperSpace object.")
- ,restricted, hidden
- ]
- HRESULT PasteSpecial(
- [in, optional] VARIANT* DataType, // Name of data format to paste.
- [in, optional] VARIANT* Link, // True to paste link.
- [in, optional] VARIANT* DisplayAsIcon, // True to display as icon.
- [in, optional] VARIANT* IconFileName, // File containing icon.
- [in, optional] VARIANT* IconIndex, // Index of icon to use if displaying as icon.
- [in, optional] VARIANT* IconLabel, // Label to display if displaying as icon.
- [in, optional] VARIANT* XRef, // X coordinate of center of object
- [in, optional] VARIANT* YRef, // Y coordinate of center of object
- [in, optional] VARIANT* ZRef, // Z coordinate of center of object
- [in, optional] VARIANT* Width, // Width of object
- [in, optional] VARIANT* Height, // Height of object
- [in, optional] VARIANT* Anchor
- );
-
- /**
- * Begins an interactive pick by rectangle.
- */
- [
- helpcontext(0x12000017)
- ,helpstring("Begins an interactive pick by rectangle.")
- ,restricted, hidden
- ]
- HRESULT PickInteractive(
- [in] ImsiPickType Type, // Point, rect or polygon pick.
- [in, optional] VARIANT* TopLevel, // True if only top level Graphic object's are to be picked.
- [in, optional] VARIANT* Arcs, // True if arcs should be returned in pick.
- [in, optional] VARIANT* Text, // True if text should be returned in pick.
- [in, optional] VARIANT* Segments, // True if only segments should be returned in pick.
- [in, optional] VARIANT* Blocks, // True if segments in blocks should be returned in pick.
- [in, optional] VARIANT* Invisible, // True if invisible segements can be picked.
- [out, retval] PickResult** prop // The result of the pick
- );
-
- /**
- * Prints the object.
- *
- */
- [
- helpcontext(0x12000018)
- ,helpstring("Prints the object.")
- ,restricted, hidden
- ]
- HRESULT PrintOut(
- [in, optional] VARIANT* From, // Starting page number.
- [in, optional] VARIANT* To, // Ending page number.
- [in, optional] VARIANT* Copies, // Number of copies to print.
- [in, optional] VARIANT* ActivePrinter, // Name of printer to use.
- [in, optional] VARIANT* OutputFileName, // File name to print to.
- [in, optional] VARIANT* FitToPage, // True to fit on one page.
- [in, optional] VARIANT* Collate // True to collate copies.
- );
-
- /**
- * Redoes the last user interface action.
- *
- */
- [
- helpcontext(0x12000019)
- ,helpstring("Redoes the last user interface action.")
- ,restricted, hidden
- ]
- HRESULT Redo(
- [in] VARIANT* Times, // Number of actions to redo.
- [out, retval] IMSI_BOOL* prop // True if the redo was successful.
- );
-
- /**
- * Repeats the last user interface action.
- *
- */
- [
- helpcontext(0x1200001A)
- ,helpstring("Repeats the last user interface action.")
- ,restricted, hidden
- ]
- HRESULT Repeat(
- [in] VARIANT* Times, // Number of actions to repeat.
- [out, retval] IMSI_BOOL* prop // True if the repeat was successful.
- );
-
- /**
- * Saves the changes to the PaperSpace object in a different file.
- *
- */
- [
- helpcontext(0x1200001B)
- ,helpstring("Saves the changes to the PaperSpace object in a different file.")
- ,restricted, hidden
- ]
- HRESULT SaveAs(
- [in] BSTR Filename, // The file name to save to.
- [in, optional] VARIANT* Filter // Name or index of preferred filter.
- );
-
- /**
- * Selects all of the Graphic object's in the PaperSpace object's Graphics collection.
- * Has the same effect as PaperSpace.Graphics.Select.
- */
- [
- helpcontext(0x1200001C)
- ,helpstring("Selects all of the Graphic object's in the PaperSpace object's Graphics collection.")
- ]
- HRESULT SelectAll(
- );
-
- /**
- * Sends the PaperSpace object as an attachment using the installed mail system.
- */
- [
- helpcontext(0x1200001D)
- ,helpstring("Sends the PaperSpace object as an attachment using the installed mail system.")
- ,restricted, hidden
- ]
- HRESULT Send(
- [in] VARIANT* Recipients, // Names of recipients, as a string or string array.
- [in, optional] VARIANT* Subject, // Subject line.
- [in, optional] VARIANT* Message, // Message.
- [in, optional] VARIANT* CCRecipients, // Names of CC recipients, as a string or string array.
- [in, optional] VARIANT* BCCRecipients, // Names of BCC recipients, as a string or string array.
- [in, optional] VARIANT* ReturnReceipt // True to request return receipt.
- );
-
- /**
- * Sends the PaperSpace object as an attachment using the installed mail system.
- * Runs a dialog to get the mail information.
- */
- [
- helpcontext(0x1200001E)
- ,helpstring("Sends the PaperSpace object as an attachment using the installed mail system.")
- ,restricted, hidden
- ]
- HRESULT SendMail(
- );
-
- /**
- * Cancels the last user interface action.
- *
- */
- [
- helpcontext(0x1200001F)
- ,helpstring("Cancels the last user interface action.")
- ,restricted, hidden
- ]
- HRESULT Undo(
- [in] VARIANT* Times, // Number of actions to undo.
- [out, retval] IMSI_BOOL* prop // True if the Undo was successful.
- );
-
- /**
- * Clears all the PaperSpace object's undo entries.
- *
- */
- [
- helpcontext(0x12000020)
- ,helpstring("Clears all the PaperSpace object's undo entries.")
- ,restricted, hidden
- ]
- HRESULT UndoClear(
- );
-
- /**
- * Unselects all of the Graphic object's in the PaperSpace object's Graphics collection.
- * Has the same effect as PaperSpace.Graphics.Unselect or PaperSpace.Selection.Unselect.
- */
- [
- helpcontext(0x12000021)
- ,helpstring("Unselects all of the Graphic object's in the PaperSpace object's Graphics collection.")
- ]
- HRESULT UnselectAll(
- );
-
- /**
- * Updates a link (or links).
- */
- [
- helpcontext(0x12000022)
- ,helpstring("Updates a link (or links).")
- ,restricted, hidden
- ]
- HRESULT UpdateLink(
- [in, optional] VARIANT* LinkName // Name of link to update.
- );
-
- ////////////////////// New stuff added here \\\\\\\\\\\\\\\\\\\\
-
- /**
- * Returns the location of the relative origin, as a Vertex object.
- */
- [
- propget
- ,helpcontext(0x12000023)
- ,helpstring("Returns the location of the relative origin from a Vertex object.")
- ,restricted, hidden
- ]
- HRESULT RelativeOrigin(
- [out, retval] IVertex** prop
- );
-
- /**
- * Sets the location of the relative origin, as a Vertex object.
- */
- [
- propput
- ,helpcontext(0x12000023)
- ,helpstring("Sets the location of the relative origin from a Vertex object.")
- ,restricted, hidden
- ]
- HRESULT RelativeOrigin(
- [in] IVertex* prop
- );
-
- /**
- * Returns the Drawing object that owns the object.
- */
- [
- propget
- ,helpcontext(0x12000024)
- ,helpstring("Returns the Drawing object that owns the object.")
- ]
- HRESULT Drawing(
- [out, retval] IDrawing** prop // The Drawing object.
- );
-
- /**
- * Returns the Drawing object that owns the object.
- */
- [
- propget
- ,helpcontext(0x12000025)
- ,helpstring("True if active Paper Space.")
- ]
- HRESULT Active(
- [out, retval] IMSI_BOOL* prop // True if active Paper Space.
- );
-
- }
-
- /**
- * The collection of PaperSpace objects contained by the PaperSpace object.
- * Enumerates the Paper Space contained by the Application.
- * Allows setting of properties and graphics for all Paper Space in the collection.
- */
- [
- object
- ,uuid(6A48114D-E531-11CF-A115-00A024158DAF)
- ,oleautomation
- ,dual
- ,helpcontext(0x12010000)
- ,helpstring("The collection of PaperSpace objects contained by the Drawing object.")
- ]
- interface PaperSpaces : IDispatch
- {
- /*//////////////////////////// Properties \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*/
-
- /**
- * Returns an Application object that represents the owner of the specified object.
- */
- [
- propget
- ,helpcontext(0x12010001)
- ,helpstring("Returns an Application object that represents the creator of the specified object.")
- ]
- HRESULT Application(
- [out, retval] IApplication** prop // The Application object.
- );
-
- /**
- * Returns the number of items in the collection.
- */
- [
- propget
- ,helpcontext(0x12010002)
- ,helpstring("Returns the number of items in the collection.")
- ]
- HRESULT Count(
- [out, retval] long* prop // The number of items.
- );
-
- /**
- * Returns part of a collection.
- */
- [
- propget
- ,id(DISPID_VALUE)
- ,helpcontext(0x12010003)
- ,helpstring("Returns part of a collection.")
- ]
- HRESULT Item(
- [in] VARIANT* Index, // Index of item to return.
- [out, retval] PaperSpace** prop // The item.
- );
-
- /**
- * Returns the parent object for the specified object.
- */
- [
- propget
- ,helpcontext(0x12010004)
- ,helpstring("Returns the parent object for the specified object.")
- ]
- HRESULT Parent(
- [out, retval] IDispatch** prop // The parent object.
- );
-
- /**
- * Creates an enumeration object.
- */
- [
- propget
- ,restricted
- ,id(DISPID_NEWENUM)
- ,helpcontext(0x12010005)
- ,helpstring("Private. Creates an enumeration object.")
- ]
- HRESULT _NewEnum(
- [out, retval] IUnknown** prop // The enumeration object.
- );
-
- /*////////////////////////////// Methods \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\*/
-
- /**
- * Adds one or more PaperSpace objects to the collection.
- */
- [
- helpcontext(0x12010006)
- ,helpstring("Adds one PaperSpace objects to the collection.")
- ]
- HRESULT Add(
- [in] BSTR bstrPaperSpaceName, // Name of the PaperSpace to add.
- [out, retval] IDispatch** ppPaperSpace// PaperSpace objects added.
- );
-
- /**
- * Returns the index within the table collection of the specified table entry.
- * Private.
- */
- [
- restricted
- ,helpcontext(0x12010007)
- ,helpstring("Private. Returns the index within the table collection of the specified table entry.")
- ]
- HRESULT _FindIndex(
- [in] long TableEntryID, // The internal table ID.
- [out, retval] long* prop // The zero based index.
- );
-
- /**
- * Returns an object from the table collection for the specified table entry.
- * Private.
- */
- [
- restricted
- ,helpcontext(0x12010008)
- ,helpstring("Private. Returns an object from the table collection for the specified table entry.")
- ]
- HRESULT _ObjectFromID(
- [in] long TableEntryID, // The internal table ID.
- [out, retval] PaperSpace** prop // The object.
- );
- }
-
- [
- uuid(6A481405-E531-11CF-A115-00A024158DAF)
- ,version(8.0)
- ,helpfile("tcsdk.chm")
- ,helpcontext(0x12020000)
- ,helpstring("GXMPS 8.0 Type Library")
- ]
- library GXMPSLib
- {
- importlib("stdole32.tlb");
- importlib("stdole2.tlb");
- importlib("..\include\imsigx.tlb");
-
- [
- uuid(6A48180C-E531-11CF-A115-00A024158DAF)
- ,hidden
- ,helpcontext(0x12020000)
- ,helpstring("A PaperSpaces collection.")
- ]
- coclass XPaperSpaces
- {
- [default] interface PaperSpaces;
- }
-
- };
-